IApi.EnableActualVelocity method

Adds the Actual Velocity variable to PDO.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError EnableActualVelocity(
       bool Active
)

Function EnableActualVelocity(
       Active As Boolean
) As KsError

Parameters

Active

Type: bool

true: The Actual Velocity variable is mapped to PDO. false: Not mapped to PDO. By default, it is false.

Return value

Type: KsError

A return code of a method.

Remarks

This method must be called after Create and before Start.

Usable EtherCAT states

ecatOffline

Examples

N/A

See also

IApi Interface

IntervalZero.KINGSTAR.Base.Api Namespace